/*
 * @(#)StringKeyDB.java	1.0 Oct 7, 2008
 *
 *	The MIT License
 *
 *	Copyright (c) 2008 Malachi de AElfweald <malachid@gmail.com>
 *
 *	Permission is hereby granted, free of charge, to any person obtaining a copy
 *	of this software and associated documentation files (the "Software"), to deal
 *	in the Software without restriction, including without limitation the rights
 *	to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 *	copies of the Software, and to permit persons to whom the Software is
 *	furnished to do so, subject to the following conditions:
 *
 *	The above copyright notice and this permission notice shall be included in
 *	all copies or substantial portions of the Software.
 *
 *	THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 *	IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 *	FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 *	AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 *	LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 *	OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 *	THE SOFTWARE.
 */
package org.eoti.db.mimir;

import org.eoti.spec.mimirdb.v1.DBMapping;

import java.util.Comparator;

public abstract class StringKeyDB<DATA>
extends MimirDB<DATA, String>
{
    private static IDComparator idComparator = new IDComparator();

    /**
     * Create an instance of a database
     *
     * @param registry  MimirRegistry responsible for maintaining the mappings
     * @param dbMapping specification for this database
     * @throws SchemeValidationException
     *          if the scheme is invalid
     * @throws SchemeNotFoundException
     *          if the scheme is not found
     */
    public StringKeyDB(MimirRegistry registry, DBMapping dbMapping)
            throws SchemeNotFoundException, MimirException
    {
        super(registry, dbMapping);
    }

    public String createID(String id)
    {
        return id;
    }

    protected String getNextID(String last)
    {
        return null;
    }

    protected Comparator<String> getIDComparator()
    {
        return idComparator;
    }

    static class IDComparator
    implements Comparator<String>
    {
        public int compare(String s1, String s2)
        {
            return s1.compareTo(s2);
        }
    }
}
